-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix URL to contributors guide #51
Fix URL to contributors guide #51
Conversation
README.md
Outdated
@@ -42,4 +42,4 @@ Would you like to contribute to `dbt-score`? That's great news! Please follow | |||
|
|||
[dbt]: https://github.com/dbt-labs/dbt-core | |||
[dbt-score]: https://dbt-score.picnic.tech/ | |||
[contributors-guide]: https://dbt-score.picnic.tech/contributors_guide | |||
[contributors-guide]: https://dbt-score.picnic.tech/CONTRIBUTING/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh damn, can we configure mkdocs to use the former URL? Uppercase doesn't look good in an URL :/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't find any such configuration unfortunately
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could make a custom redirect using something like this https://github.com/mkdocs/mkdocs-redirects
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The redirect works, but at the end of the day it's still a redirect so the URL in your address bar will still be CONTRIBUTING/
. The only value it would bring is that the URLs in this readme look a bit nicer, but I wouldn't install a whole plugin just for that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I had the impression it would be an url-rewrite instead of a simple redirect. Or actually
During the mkdocs build process, this plugin will create .html files in site_dir for each of the "old" file that redirects to the "new" path
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A simpler solution might be to rename CONTRIBUTING.md
to contributing.md
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whilst they suggest to create a file name CONTRIBUTING
it does indeed look like lower-case is also supported
Contributing guidelines filenames are not case sensitive
(docs)
No description provided.